OpenEdge Reporting:<br />Query/Results for UNIX Using customized help messages

When users press HELP, Results calls a procedure called applhelp.p. Most applications have their own applhelp.p that contains help instructions for their own products. Example 10–1 shows the source code for Results help.

Example 10–1: applhelp.p
/* applhelp.p - PROGRESS RESULTS applhelp.p / DEFINE SHARED VARIABLE qbf-direct AS CHARACTER NO-UNDO. DEFINE SHARED VARIABLE qbf-module AS CHARACTER NO-UNDO. DEFINE VARIABLE qbf-c AS CHARACTER INITIAL ? NO-UNDO. IF qbf-module = "f" THEN qbf-c = SEARCH("ft.r"). IF qbf-c <> ? THEN DO: / FAST TRACK help / RUN VALUE(qbf-direct + "s-prefix.p") (qbf-c,OUTPUT qbf-c). RUN VALUE(qbf-c + "applhelp.p"). RETURN. END. IF LENGTH(qbf-module) > 0 THEN DO: / RESULTS help / RUN VALUE(qbf-direct + "s-help.p"). RETURN. END. / Put your own help routine here */

Example 10–1: applhelp.p

/* applhelp.p - PROGRESS RESULTS applhelp.p */

DEFINE SHARED VARIABLE qbf-direct AS CHARACTER NO-UNDO.
DEFINE SHARED VARIABLE qbf-module AS CHARACTER NO-UNDO.

DEFINE VARIABLE qbf-c AS CHARACTER INITIAL ? NO-UNDO.

IF qbf-module = "f" THEN qbf-c = SEARCH("ft.r").
IF qbf-c <> ? THEN DO: /* FAST TRACK help */
  RUN VALUE(qbf-direct + "s-prefix.p") (qbf-c,OUTPUT qbf-c).
  RUN VALUE(qbf-c + "applhelp.p").
  RETURN.
END.

IF LENGTH(qbf-module) > 0 THEN DO: /* RESULTS help */
  RUN VALUE(qbf-direct + "s-help.p").
  RETURN.
END.

/* Put your own help routine here */

If you place this routine at the top of your application help, you enable online help to work correctly for Results as well as your application’s help system.

You must invoke the help supplied with Results when the qbf-module variable shown in the source code contains text. The "Determining the originating module" section describes the qbf-module variable.